The UserAccounts API allows you get the information about the user groups created on a Fabric-enabled LogPoint.
The PermissionGroups API allows you to configure and manage the permission groups in a Fabric-enabled LogPoint. Refer to the Permission Groups section for more details.
Endpoint |
Description |
|---|---|
Create |
Creates a permission group in a Fabric-enabled LogPoint. |
Edit |
Updates the permission group with the given ID. |
Get |
Fetches the permission group with the given ID. |
List |
Lists all the permission groups in a Fabric-enabled LogPoint. |
Trash |
Deletes the permission group with the given ID. |
Note
You can use the PermissionGroup API for Fabric-enabled LogPoint v6.12.0 and later.
The UsersGroups API allows you to create and manage the user groups in the Fabric-enabled LogPoint. Refer to the User Groups section for more details.
Endpoint |
Description |
|---|---|
Create |
Creates a new user group in a Fabric-enabled LogPoint. |
Edit |
Edits the configuration of the user group with the given ID. |
Get |
Fetches the user group with the given ID. |
List |
Lists the user groups in the Fabric-enabled LogPoint. |
RefreshList |
Syncs the user group with LogPoint’s user groups. |
Trash |
Deletes the user group with the given ID. |
Note
You can use the following endpoints for Fabric-enabled LogPoint v6.12.0 and later:
UserGroups - Create
UserGroups - Edit
UserGroups - Trash
The UserGroups API can only be used for mapping user groups for the LDAP Authentication. The LDAP users cannot create new user groups or edit their roles.
The Users API allows you to create and manage the users in the Fabric-enabled LogPoint. Refer to the Users section for more details.
Endpoint |
Description |
|---|---|
Activate |
Activates the user with the given ID. |
ChangePassword |
Updates the password of the user with the given ID. |
Create |
Creates a new user in the Fabric-enabled LogPoint. |
Deactivate |
Deactivates the user with the given ID. |
Edit |
Updates the configuration of the user with the given ID. |
Get |
Fetches the user with the given ID. |
List |
Lists all users in the Fabric-enabled LogPoint. |
RefreshList |
Syncs the existing users with LogPoint’s users. |
Trash |
Deletes the user with the given ID. |
Unlock |
Unlocks the user with the given ID. |
Note
You can configure and manage users’ endpoints for Fabric-enabled LogPoint v6.12.0 and later.
The Users API does not allow you to create and manage the plugin users for the authentication plugins. Currently, LogPoint supports the following authentication plugins:
LDAP Authentication
Radius Authentication
ADFS Authentication
SAML Authentication
OAuth Authentication
The IncidentUserGroups API allows you to list the incident user groups in the Fabric-enabled LogPoint.
Endpoint |
Description |
|---|---|
Create |
Creates an incident user group in a Fabric-enabled LogPoint. |
Get |
Fetches the incident user group with the given ID. |
List |
Lists all the incident user groups in a Fabric-enabled LogPoint. |
Trash |
Deletes the incident user group with the given ID. |
The SystemSettingsNTP API allows you to configure and manage NTP settings on behalf of a Fabric-enabled LogPoint. NTP synchronizes the time of your appliance with a network time server.
Endpoint |
Description |
|---|---|
List |
Lists the NTP settings. |
NTPRestart |
Restarts the NTP Server if it is enabled in the Fabric-enabled LogPoint. |
Save |
Updates the existing NTP settings. |
The SystemSettingsSMTP API allows you to configure and manage SMTP settings on behalf of a Fabric-enabled LogPoint.
SMTP is used to send emails from the Fabric-enabled LogPoint. The alert engine uses SMTP service to forward information. You need to configure the SMTP service before using the Fabric-enabled LogPoint to send emails.
Endpoint |
Description |
|---|---|
List |
Lists the SMTP settings. |
SMTPTest |
Tests the SMTP settings. |
Save |
Updates the existing SMTP settings. |
The SystemSettingsSNMP API allows you to configure and manage SNMP settings on behalf of a Fabric-enabled LogPoint.
Endpoint |
Description |
|---|---|
List |
Lists the SNMP settings. |
Save |
Updates the existing SNMP settings. |
The SystemSettingsSSH API allows you to configure and manage SSH settings on behalf of a Fabric-enabled LogPoint. SSH settings generate SSH certificates for the li-admin user.
Endpoint |
Description |
|---|---|
List |
Lists the SSH settings. |
Save |
Updates the exisitng SSH settings. |
The SystemSettingsSupportConnection API allows you to configure and manage support connection settings on behalf of a Fabric-enabled LogPoint.
The support connection creates an encrypted end-to-end communication channel between the Fabric-enabled LogPoint and the LogPoint support.
Endpoint |
Description |
|---|---|
List |
Lists the support connection settings. |
RefreshList |
Syncs the current support connection settings list with LogPoint’s support connection settings. |
Save |
Updates the existing support connection settings. |
The SystemSettingsModeOfOperation API allows you to set a mode of operation of a Fabric-enabled LogPoint.
A Fabric-enabled LogPoint can be operated in two modes: LogPoint Collector and Syslog Forwarder.
Endpoint |
Description |
|---|---|
List |
Lists the modes of operation settings. |
Save |
Updates the existing mode of operation to a LogPoint Collector or a Syslog Forwarder. |
The SystemSettingsHTTPS API allows you to configure and manage HTTPS settings on behalf of a Fabric-enabled LogPoint.
The HTTPS service authenticates the Fabric-enabled LogPoint and prevents eavesdroppers from accessing the data in the network. HTTPS secures the server connection so that the Fabric-enabled LogPoint can easily be accessed from the Internet.
You must have a certificate and a key to enable the HTTPS option.
Endpoint |
Description |
|---|---|
InstallCertificate |
Installs the certificate and key uploaded in the Fabric Storage to the Fabric-enabled LogPoint. |
List |
Lists the keys and certificate in the private storage for the requested pool. |
ListPublic |
Lists the keys and certificate in the public storage for the requested pool. |
TrashPrivate |
Deletes the file with the given name from the private storage. |
TrashPublic |
Deletes the file with the given name from the public storage. |
UploadCertificate |
Uploads the certificate and key files to the Fabric storage. |
UploadCertificateToPool |
Uploads the certificate and key files to the private storage. |
The Upload API allows you to upload applications to the Fabric Storage for installation on the Fabric-enabled LogPoint.
If you upload the plugins or applications privately (using the Upload - Upload endpoint), they are only accessible within a specific LogPoint Pool. If you upload the plugins or applications publicly (using the Upload - UploadPublic endpoint), they are accessible by all LogPoint pools in the Director setup.
Endpoint |
Description |
|---|---|
Install |
Installs the applications and patches already uploaded to the Fabric Storage, to the Fabric-enabled LogPoint. |
List |
Lists the files in private storage. |
ListPublic |
Lists the files in the public storage. |
TrashPrivate |
Deletes the file with the given name from the private storage. |
TrashPublic |
Deletes the file with the given name from the public storage. |
Upload |
Uploads files to the private storage. |
UploadPublicFiles |
Uploads files to the public storage. |
The OpenDoor API allows you to enable connections between a Fabric-enabled LogPoint and remote LogPoint.
When enabled, a remote LogPoint can add your Fabric-enabled LogPoint machine as its Distributed LogPoint. After enabling Open Door and configuring the remote LogPoints for a distributed network, you can centrally manage logs from a remote location. Under distributed architecture, the central server controls and manages the remote LogPoints.
Endpoint |
Description |
|---|---|
Create |
Adds a new remote connection. |
Get |
Fetches details of a remote connection by the given Open Door ID. |
List |
Lists the remote connections. |
The BackupAndRestore API allows you to create and restore backups on behalf of a Fabric-enabled LogPoint.
Using this API, you can create a backup of repos and configurations of a Fabric-enabled LogPoint, and restore them in the future.
Endpoint |
Description |
|---|---|
BackupNow |
Adds a backup of files at the current time. |
CreateConfigBackup |
Backs up the configuration details of Fabric-enabled LogPoint and all of its collectors or fetchers. |
CreateLogsChecksumBackup |
Backs up the logs, index of the logs and the checksum of the logs of the Fabric-enabled LogPoint. |
Get |
Fetches the backup data with the given ID. |
List |
Lists the backup data. |
ListSettings |
Lists the backup and restore settings. |
LogChecksumBackupNow |
Backs up the logs, index of the logs, and the checksum of the logs of the Fabric-enabled LogPoint at the current time. |
RefreshList |
Updates the list of backup schedule. |
Restore |
Restores the backup data. |
Trash |
Deletes the backup data with the given ID. |
The Snapshots API allows you to save the state of a Fabric-enabled LogPoint so that you can revert to it at any time in the future.
A snapshot captures the entire state of the system. It preserves the Fabric-enabled LogPoint’s data just as it was when you took the snapshot.
Note
The Snapshots feature is available only from LogPoint v6.0.0 ISO.
Endpoint |
Description |
|---|---|
Create |
Adds a new snapshot of a machine. |
Get |
Fetches a snapshot with the given ID. |
List |
Lists the snapshots. |
Revert |
Reverts to the snapshot with the given ID. |
Trash |
Deletes the snapshot with the given ID. |
The Plugins API allows you to get information about the plugins installed on a Fabric-enabled LogPoint. You can also uninstall plugins on behalf of a Fabric-enabled LogPoint.
Plugins or pluggable components are similar to the browser add-ons that can be used to support extra functionaties in a Fabric-enabled LogPoint.
Endpoint |
Description |
|---|---|
Get |
Fetches the plugin with the given ID. |
List |
Lists the plugins. |
Uninstall |
Uninstalls the plugin with the given ID. |